Current Limit 4 Click Driver

API for configuring and manipulating Current Limit 4 Click driver. More...

Topics
	Current Limit 4 Settings
	Settings of Current Limit 4 Click driver.
	Current Limit 4 MikroBUS Map
	MikroBUS pin mapping of Current Limit 4 Click driver.

Functions
void	currentlimit4_cfg_setup (currentlimit4_cfg_t *cfg)
	Current Limit 4 configuration object setup function.
err_t	currentlimit4_init (currentlimit4_t *ctx, currentlimit4_cfg_t *cfg)
	Current Limit 4 initialization function.
err_t	currentlimit4_default_cfg (currentlimit4_t *ctx)
	Current Limit 4 default configuration function.
void	currentlimit4_enable (currentlimit4_t *ctx)
	Current Limit 4 enable function.
void	currentlimit4_disable (currentlimit4_t *ctx)
	Current Limit 4 disable function.
uint8_t	currentlimit4_get_power_good (currentlimit4_t *ctx)
	Current Limit 4 power good indication function.
err_t	currentlimit4_read_raw_adc (currentlimit4_t *ctx, uint16_t *raw_adc)
	Current Limit 4 read raw ADC value function.
err_t	currentlimit4_read_voltage (currentlimit4_t *ctx, float *voltage)
	Current Limit 4 read voltage level function.
err_t	currentlimit4_set_vref (currentlimit4_t *ctx, float vref)
	Current Limit 4 set vref function.
err_t	currentlimit4_get_current (currentlimit4_t *ctx, float *current)
	Current Limit 4 get current function.
err_t	currentlimit4_set_wiper_pos (currentlimit4_t *ctx, uint16_t wiper_pos)
	Current Limit 4 set wiper position function.
err_t	currentlimit4_set_res (currentlimit4_t *ctx, uint16_t res_ohm)
	Current Limit 4 set resistance function.
err_t	currentlimit4_set_limit (currentlimit4_t *ctx, uint16_t ilimit_ma)
	Current Limit 4 set current limit function.

Detailed Description

API for configuring and manipulating Current Limit 4 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

currentlimit4_cfg_setup()

void currentlimit4_cfg_setup

(

currentlimit4_cfg_t *

cfg

)

Current Limit 4 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See currentlimit4_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

currentlimit4_default_cfg()

err_t currentlimit4_default_cfg

(

currentlimit4_t *

ctx

)

Current Limit 4 default configuration function.

This function executes a default configuration of Current Limit 4 Click board.

Parameters

[in]

ctx

: Click context object. See currentlimit4_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

This function can consist any necessary configuration or setting to put device into operating mode.

currentlimit4_disable()

void currentlimit4_disable

(

currentlimit4_t *

ctx

)

Current Limit 4 disable function.

This function disables the current limiting switch of the TPS25980, 2.7-24V, 8A, 3m Smart eFuse - Integrated Hot-swap Protection With Adjustable Transient Fault Management on the Current Limit 4 Click board.

Parameters

[in]

ctx

: Click context object. See currentlimit4_t object definition for detailed explanation.

Returns

Nothing.

Note

None.

currentlimit4_enable()

void currentlimit4_enable

(

currentlimit4_t *

ctx

)

Current Limit 4 enable function.

This function enables the current limiting switch of the TPS25980, 2.7-24V, 8A, 3m Smart eFuse - Integrated Hot-swap Protection With Adjustable Transient Fault Management on the Current Limit 4 Click board.

Parameters

[in]

ctx

: Click context object. See currentlimit4_t object definition for detailed explanation.

Returns

Nothing.

Note

None.

currentlimit4_get_current()

err_t currentlimit4_get_current	(	currentlimit4_t *	ctx,
		float *	current )

Current Limit 4 get current function.

This function reads and calculate input current value of the TPS25980, 2.7-24V, 8A, 3m Smart eFuse - Integrated Hot-swap Protection With Adjustable Transient Fault Management on the Current Limit 4 Click board.

Parameters

[in]	ctx	: Click context object. See currentlimit4_t object definition for detailed explanation.
[out]	current	: Current [A].

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

The conversion to voltage depends on the entered reference voltage.

currentlimit4_get_power_good()

uint8_t currentlimit4_get_power_good

(

currentlimit4_t *

ctx

)

Current Limit 4 power good indication function.

This function is used as power good indication of the TPS25980, 2.7-24V, 8A, 3m Smart eFuse - Integrated Hot-swap Protection With Adjustable Transient Fault Management on the Current Limit 4 Click board.

Parameters

[in]

ctx

: Click context object. See currentlimit4_t object definition for detailed explanation.

Returns

• 0 - Input voltage is lower then undervoltage protection threshold [Vin < Vuvp],
• 1 - Normal operation.

Note

None.

currentlimit4_init()

err_t currentlimit4_init	(	currentlimit4_t *	ctx,
		currentlimit4_cfg_t *	cfg )

Current Limit 4 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See currentlimit4_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See currentlimit4_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

currentlimit4_read_raw_adc()

err_t currentlimit4_read_raw_adc	(	currentlimit4_t *	ctx,
		uint16_t *	raw_adc )

Current Limit 4 read raw ADC value function.

This function reads raw ADC value.

Parameters

[in]	ctx	: Click context object. See currentlimit4_t object definition for detailed explanation.
[out]	raw_adc	: Output ADC result.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

currentlimit4_read_voltage()

err_t currentlimit4_read_voltage	(	currentlimit4_t *	ctx,
		float *	voltage )

Current Limit 4 read voltage level function.

This function reads raw ADC value and converts it to proportional voltage level.

Parameters

[in]	ctx	: Click context object. See currentlimit4_t object definition for detailed explanation.
[out]	voltage	: Output voltage level [V].

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

The conversion to voltage depends on the entered reference voltage.

currentlimit4_set_limit()

err_t currentlimit4_set_limit	(	currentlimit4_t *	ctx,
		uint16_t	ilimit_ma )

Current Limit 4 set current limit function.

This function sets the current limit of the TPS25980, 2.7-24V, 8A, 3m Smart eFuse - Integrated Hot-swap Protection With Adjustable Transient Fault Management on the Current Limit 4 Click board.

Parameters

[in]	ctx	: Click context object. See currentlimit4_t object definition for detailed explanation.
[in]	current_limit	: Current limit (400mA to 3700mA).

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

currentlimit4_set_res()

err_t currentlimit4_set_res	(	currentlimit4_t *	ctx,
		uint16_t	res_ohm )

Current Limit 4 set resistance function.

This function sets the resistance of the MCP4561, 8-Bit Single I2C Digital POT with Nonvolatile Memory on the Current Limit 4 Click board.

Parameters

[in]	ctx	: Click context object. See currentlimit4_t object definition for detailed explanation.
[in]	res_kohm	: Resistance [0-5000kOhm].

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

currentlimit4_set_vref()

err_t currentlimit4_set_vref	(	currentlimit4_t *	ctx,
		float	vref )

Current Limit 4 set vref function.

This function sets the voltage reference for Current Limit 4 Click driver.

Parameters

[in]	ctx	: Click context object. See currentlimit4_t object definition for detailed explanation.
[in]	vref	: Reference voltage (volts).

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

The default voltage reference set with currentlimit4_init is 3.3V.

currentlimit4_set_wiper_pos()

err_t currentlimit4_set_wiper_pos	(	currentlimit4_t *	ctx,
		uint16_t	wiper_pos )

Current Limit 4 set wiper position function.

This function sets the position of the wiper position of the MCP4561, 8-Bit Single I2C Digital POT with Nonvolatile Memory on the Current Limit 4 Click board.

Parameters

[in]	ctx	: Click context object. See currentlimit4_t object definition for detailed explanation.
[in]	wiper_pos	: Wiper position [0-256].

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.